package stackdriver

Import Path
	github.com/K-Phoen/grabana/target/stackdriver (on go.dev)

Dependency Relation
	imports one package, and imported by 6 packages

Involved Source Files

	    alignment_options.go
	    filters.go
	    stackdriver.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type Aligner string (basic type)
		Aligner specifies the operation that will be applied to the data points in
		each alignment period in a time series.
		See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#Aligner

		As Inputs Of (at least one exported)
			func Alignment(aligner Aligner, alignmentPeriod string) Option
		As Types Of (total 19)
			const AlignCount
			const AlignCountFalse
			const AlignCountTrue
			const AlignDelta
			const AlignFractionTrue
			const AlignInterpolate
			const AlignMax
			const AlignMean
			const AlignMin
			const AlignNextOlder
			const AlignNone
			const AlignPercentChange
			const AlignPercentile05
			const AlignPercentile50
			const AlignPercentile95
			const AlignPercentile99
			const AlignRate
			const AlignStdDev
			const AlignSum

	 type FilterOption (func)

		As Outputs Of (at least 4)
			func Eq(leftOperand string, rightOperand string) FilterOption
			func Matches(leftOperand string, rightOperand string) FilterOption
			func Neq(leftOperand string, rightOperand string) FilterOption
			func NotMatches(leftOperand string, rightOperand string) FilterOption
		As Inputs Of (at least one exported)
			func Filter(filters ...FilterOption) Option

	 type Option (func)
		Option represents an option that can be used to configure a stackdriver query.

		As Outputs Of (at least 9)
			func Aggregation(reducer Reducer) Option
			func Alignment(aligner Aligner, alignmentPeriod string) Option
			func Filter(filters ...FilterOption) Option
			func GroupBys(groupBys ...string) Option
			func Hide() Option
			func Legend(legend string) Option
			func Preprocessor(preprocessor PreprocessorMethod) Option
			func Project(project string) Option
			func Ref(ref string) Option
		As Inputs Of (at least 3)
			func Cumulative(metricType string, options ...Option) *Stackdriver
			func Delta(metricType string, options ...Option) *Stackdriver
			func Gauge(metricType string, options ...Option) *Stackdriver

	 type PreprocessorMethod string (basic type)
		PreprocessorMethod defines the available pre-processing options.

		As Inputs Of (at least one exported)
			func Preprocessor(preprocessor PreprocessorMethod) Option

	 type Reducer string (basic type)
		Reducer operation describes how to aggregate data points from multiple time
		series into a single time series, where the value of each data point in the
		resulting series is a function of all the already aligned values in the
		input time series.
		See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#reducer

		As Inputs Of (at least one exported)
			func Aggregation(reducer Reducer) Option
		As Types Of (total 14)
			const ReduceCount
			const ReduceCountFalse
			const ReduceCountFractionTrue
			const ReduceCountTrue
			const ReduceMax
			const ReduceMean
			const ReduceMin
			const ReduceNone
			const ReducePercentile05
			const ReducePercentile50
			const ReducePercentile95
			const ReducePercentile99
			const ReduceStdDev
			const ReduceSum

	 type Stackdriver (struct)
		Stackdriver represents a stackdriver query.

		Fields (only one)
			Builder *sdk.Target
		As Outputs Of (at least 3)
			func Cumulative(metricType string, options ...Option) *Stackdriver
			func Delta(metricType string, options ...Option) *Stackdriver
			func Gauge(metricType string, options ...Option) *Stackdriver
		As Inputs Of (at least 6)
			func github.com/K-Phoen/grabana/gauge.WithStackdriverTarget(target *Stackdriver) gauge.Option
			func github.com/K-Phoen/grabana/graph.WithStackdriverTarget(target *Stackdriver) graph.Option
			func github.com/K-Phoen/grabana/heatmap.WithStackdriverTarget(target *Stackdriver) heatmap.Option
			func github.com/K-Phoen/grabana/singlestat.WithStackdriverTarget(target *Stackdriver) singlestat.Option
			func github.com/K-Phoen/grabana/stat.WithStackdriverTarget(target *Stackdriver) stat.Option
			func github.com/K-Phoen/grabana/timeseries.WithStackdriverTarget(target *Stackdriver) timeseries.Option


Package-Level Functions (total 16)

	 func Aggregation(reducer Reducer) Option
		Aggregation defines how the time series will be aggregated.

	 func Alignment(aligner Aligner, alignmentPeriod string) Option
		Alignment defines how the time series will be aligned.

	 func Cumulative(metricType string, options ...Option) *Stackdriver
		Cumulative represents a value accumulated over a time interval. Cumulative
		measurements in a time series should have the same start time and
		increasing end times, until an event resets the cumulative value to zero
		and sets a new start time for the following points.

	 func Delta(metricType string, options ...Option) *Stackdriver
		Delta represents the change in a value during a time interval.

	 func Eq(leftOperand string, rightOperand string) FilterOption
	 func Filter(filters ...FilterOption) Option
		Filter allows to specify which time series will be in the results.

	 func Gauge(metricType string, options ...Option) *Stackdriver
		Gauge represents an instantaneous measurement of a value.

	 func GroupBys(groupBys ...string) Option
		GroupBys defines a list of fields to group the query by.

	 func Hide() Option
		Hide the query. Grafana does not send hidden queries to the data source,
		but they can still be referenced in alerts.

	 func Legend(legend string) Option
		Legend sets the legend format.
		See https://grafana.com/docs/grafana/latest/features/datasources/stackdriver/#alias-patterns for more
		information on allowed patterns.

	 func Matches(leftOperand string, rightOperand string) FilterOption
	 func Neq(leftOperand string, rightOperand string) FilterOption
	 func NotMatches(leftOperand string, rightOperand string) FilterOption
	 func Preprocessor(preprocessor PreprocessorMethod) Option
		Preprocessor defines how the time series should be pre-processed.

	 func Project(project string) Option
		Project defines the GCP project to use for this target.

	 func Ref(ref string) Option
		Ref sets the reference ID for this query.


Package-Level Constants (total 37)

	const AlignCount Aligner = "ALIGN_COUNT"
	const AlignCountFalse Aligner = "ALIGN_COUNT_FALSE"
	const AlignCountTrue Aligner = "ALIGN_COUNT_TRUE"
	const AlignDelta Aligner = "ALIGN_DELTA"
	const AlignFractionTrue Aligner = "ALIGN_FRACTION_TRUE"
	const AlignInterpolate Aligner = "ALIGN_INTERPOLATE"
	const AlignMax Aligner = "ALIGN_MAX"
	const AlignMean Aligner = "ALIGN_MEAN"
	const AlignmentGrafanaAuto = "grafana-auto"
	const AlignmentStackdriverAuto = "stackdriver-auto"
	const AlignMin Aligner = "ALIGN_MIN"
	const AlignNextOlder Aligner = "ALIGN_NEXT_OLDER"
	const AlignNone Aligner = "ALIGN_NONE"
	const AlignPercentChange Aligner = "ALIGN_PERCENT_CHANGE"
	const AlignPercentile05 Aligner = "ALIGN_PERCENTILE_05"
	const AlignPercentile50 Aligner = "ALIGN_PERCENTILE_50"
	const AlignPercentile95 Aligner = "ALIGN_PERCENTILE_95"
	const AlignPercentile99 Aligner = "ALIGN_PERCENTILE_99"
	const AlignRate Aligner = "ALIGN_RATE"
	const AlignStdDev Aligner = "ALIGN_STDDEV"
	const AlignSum Aligner = "ALIGN_SUM"
	const PreprocessDelta = "delta"
	const PreprocessRate = "rate"
	const ReduceCount Reducer = "REDUCE_COUNT"
	const ReduceCountFalse Reducer = "REDUCE_COUNT_FALSE"
	const ReduceCountFractionTrue Reducer = "REDUCE_FRACTION_TRUE"
	const ReduceCountTrue Reducer = "REDUCE_COUNT_TRUE"
	const ReduceMax Reducer = "REDUCE_MAX"
	const ReduceMean Reducer = "REDUCE_MEAN"
	const ReduceMin Reducer = "REDUCE_MIN"
	const ReduceNone Reducer = "REDUCE_NONE"
	const ReducePercentile05 Reducer = "REDUCE_PERCENTILE_05"
	const ReducePercentile50 Reducer = "REDUCE_PERCENTILE_50"
	const ReducePercentile95 Reducer = "REDUCE_PERCENTILE_95"
	const ReducePercentile99 Reducer = "REDUCE_PERCENTILE_99"
	const ReduceStdDev Reducer = "REDUCE_STDDEV"
	const ReduceSum Reducer = "REDUCE_SUM"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.